Repository navigation
[docs] Document the Batcher and CacheKey features - #1728
Open
andrewnicols wants to merge 1 commit into
Open
andrewnicols wants to merge 1 commit into
andrewnicols wants to merge 1 commit into
Conversation
andrewnicols
added
the
blocked-by-tracker
✅ Deploy Preview for moodledevdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The documented URLs and minimum-version guidance need correction before developers can reliably use the examples.
3 open findings
What changed in this PR
Adds developer guides for request batching and cacheable routes in Moodle’s REST API.
Changes:
- Documents automatic and manual
core/fetchbatching. - Explains route cache lifetimes, cache keys, headers, and batching interactions.
| File | Description |
|---|---|
| docs/guides/javascript/ajax/batcher.md | Explains batching usage and configuration. |
| docs/apis/subsystems/routing/caching.md | Documents cacheable routes and JavaScript requests. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| - Performance | ||
| --- | ||
|
|
||
| <Since version="6.0" issueNumber="MDL-82652" /> |
|
|
||
| ```php title="A cacheable route" | ||
| #[\core\router\route( | ||
| path: '/strings/{language}/{component}[/{identifier:.*}]', |
Comment on lines
+41
to
+42
| /api/rest/v2/strings/en/core # No cache key - not cached | ||
| /api/rest/v2/cachekey:1737584047/strings/en/core # Cacheable |
andrewnicols
force-pushed
the
MDL-82652
branch
from
October 30, 2026 03:43
477d270 to
b912734
Compare
|
|
||
| `cachelifetime` accepts any relative time string understood by [`DateInterval::createFromDateString()`](https://www.php.net/manual/en/dateinterval.createfromdatestring.php), for example `'90 days'`. | ||
|
|
||
| ```php title="A cacheable route" |
Collaborator
There was a problem hiding this comment.
Should we add cookies: false to the example? Plugin developers will copy it, and without it they'd hit the same bug the strings route had: every request starts a session, and proxies won't cache a response that sets a cookie.
| ```js | ||
| import Fetch from 'core/fetch'; | ||
|
|
||
| const response = await Fetch.performGet('core', `strings/en/core`, {cachekey: M.cfg.jsrev}); |
Collaborator
There was a problem hiding this comment.
- {cachekey: M.cfg.jsrev}
+ {cachekey: M.cfg.langrev}As the code has at stringUtils.ts:156,194
| Requests made with a `cachekey` (see [route caching](../../../apis/subsystems/routing/caching.md)) are sent individually, even via a batcher. Hiding them inside a generic `$batch` request would prevent browsers and reverse proxies caching each URL. | ||
|
|
||
| ```js | ||
| const response = await Fetch.getBatcher().performGet('core', 'strings/en/core', {cachekey: M.cfg.jsrev}); |
Collaborator
There was a problem hiding this comment.
- {cachekey: M.cfg.jsrev}
+ {cachekey: M.cfg.langrev}As the code has at stringUtils.ts:156,194
| /api/rest/v2/cachekey:1737584047/strings/en/core # Cacheable | ||
| ``` | ||
|
|
||
| Because the cache key forms part of the URI, changing it (typically by using the current JavaScript/theme revision) invalidates every cached copy of the resource. You do not need to declare the parameter yourself. |
Collaborator
There was a problem hiding this comment.
Suggestion:
- Because the cache key forms part of the URI, changing it (typically by using the current JavaScript/theme revision) invalidates every cached copy of the resource.
+ Because the cache key forms part of the URI, changing it invalidates every cached copy of the resource. Use the revision that changes with the resource: `M.cfg.langrev` for strings, `M.cfg.templaterev` for templates.
|
|
||
| :::danger | ||
|
|
||
| Responses are cached as `public` and `immutable`. Only use `cachelifetime` for routes whose response is identical for every user and which never contains private data. |
Collaborator
There was a problem hiding this comment.
I suggest adding to the danger note:
Responses are cached as `public` and `immutable`. Only use `cachelifetime` for routes whose response is identical for every user and which never contains private data.
+
+ Anything the response varies by, such as the language or the theme, must be part of the path. Caches store responses by URL, so a value sent in a request header is ignored, and every user would get whichever version was requested first.| ## Behaviour notes {/* #behaviour-notes */} | ||
|
|
||
| - If a batch contains a single request, the batch endpoint is _not_ used; it is sent as a normal request. | ||
| - The queue is flushed automatically once it holds more than 20 requests. |
Collaborator
There was a problem hiding this comment.
The check is now >= 20, so a batch holds at most 20 requests rather than "more than 20"
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
MDL-82652